Document gtk_builder_extend_wth_template
authorMatthias Clasen <mclasen@redhat.com>
Sun, 8 Nov 2015 23:40:35 +0000 (18:40 -0500)
committerMatthias Clasen <mclasen@redhat.com>
Mon, 9 Nov 2015 00:21:39 +0000 (19:21 -0500)
docs/reference/gtk/gtk3-sections.txt
gtk/gtkbuilder.c

index 858c0c736f9a0732d73a2750529bfbf786f3f23f..e8ad7578a42aa2d2bbae50735b16997fe199962e 100644 (file)
@@ -628,6 +628,7 @@ gtk_builder_add_from_string
 gtk_builder_add_objects_from_file
 gtk_builder_add_objects_from_string
 gtk_builder_add_objects_from_resource
+gtk_builder_extend_with_template
 gtk_builder_get_object
 gtk_builder_get_objects
 gtk_builder_expose_object
index 07e0bb2d30af19af6e5a439bddf9fb6ad762bd11..c074eb52adf43e8f6e9d1ea51cd6af1075b14242 100644 (file)
@@ -1110,10 +1110,23 @@ gtk_builder_add_objects_from_file (GtkBuilder   *builder,
   return 1;
 }
 
-/* Main private entry point for building composite container
+
+/**
+ * gtk_builder_extend_with_template:
+ * @builder: a #GtkBuilder
+ * @widget: the widget that is being extended
+ * @template_type: the type that the template is for
+ * @buffer: the string to parse
+ * @length: the length of @buffer (may be -1 if @buffer is nul-terminated)
+ * @error: (allow-none): return location for an error, or %NULL
+ *
+ * Main private entry point for building composite container
  * components from template XML.
+ *
  * This is exported purely to let gtk-builder-tool validate
  * templates, applications have no need to call this function.
+ *
+ * Returns: A positive value on success, 0 if an error occurred
  */
 guint
 gtk_builder_extend_with_template (GtkBuilder   *builder,